Clarify docs for gdk_rectangle_union

This function does not ignore empty rectangles. Since this
is a fairly subtle point about the behavior, it is worth
spelling this out in the documentation. We've had a bug
open about this for a long time:

https://bugzilla.gnome.org/show_bug.cgi?id=464528

diff --git a/gdk/gdkrectangle.c b/gdk/gdkrectangle.c
index 84abd2ffd7312c6e9020948a88579aae7a01133e..491de6c1e5f8115242ac536da8f2f5adeafe7d4d 100644 (file)
--- a/gdk/gdkrectangle.c
+++ b/gdk/gdkrectangle.c
@@ -58,6 +58,9 @@
  * The union of rectangles @src1 and @src2 is the smallest rectangle which
  * includes both @src1 and @src2 within it.
  * It is allowed for @dest to be the same as either @src1 or @src2.
+ *
+ * Note that this function does not ignore 'empty' rectangles (ie. with
+ * zero width or height).
  */
 void
 gdk_rectangle_union (const GdkRectangle *src1,